home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / lwatch.zip / README.DOC < prev    next >
Text File  |  1990-11-07  |  15KB  |  592 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                  tm 
  9.                        Hyper_Word  Readme Documentation 
  10.                           Copyright 1990 by Ed Zaron 
  11.                              All Rights Reserved. 
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                  Introduction . . . . . . . . . . . . . . . 2 
  20.  
  21.                  Command Line Parameters. . . . . . . . . . 4 
  22.  
  23.                      Filename . . . . . . . . . . . . . . . 4 
  24.                      Video Mode . . . . . . . . . . . . . . 5 
  25.                      Window Color . . . . . . . . . . . . . 5 
  26.                      Scroll Enable. . . . . . . . . . . . . 5 
  27.                      Window Size. . . . . . . . . . . . . . 6 
  28.  
  29.                  Default Command Line Parameters. . . . . . 6 
  30.  
  31.                  Using a Batch file to Run Readme . . . . . 7 
  32.  
  33.                  Mouse Support. . . . . . . . . . . . . . . 7 
  34.  
  35.                  Keyword Files. . . . . . . . . . . . . . . 8 
  36.  
  37.                  Printer Initialization File. . . . . . . . 8 
  38.  
  39.                  Limitations. . . . . . . . . . . . . . . . 9 
  40.  
  41.                  Disclaimer . . . . . . . . . . . . . . . . 9 
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                       1 
  64.  
  65.  
  66.  
  67.  
  68.  
  69.          Introduction 
  70.          -------------- 
  71.  
  72.          The Hyper-Word Readme program is a read only, single window, 
  73.          run time version of our Hyper-Word(tm) word processing 
  74.          program. 
  75.  
  76.          You are free to copy and distribute Hyper-Word Readme (file 
  77.          README.EXE) so long as you do not change any of Readme's 
  78.          internal code or messages. 
  79.  
  80.  
  81.  
  82.          The Gray + and Gray - keys. 
  83.          --------------------------- 
  84.  
  85.          Within Readme files created with our Hyper-Word word 
  86.          processor, the gray + and gray - keys serve a special 
  87.          function. 
  88.  
  89.          Pressing the gray + key over a highlighted word will get 
  90.          additional information. 
  91.  
  92.          Pressing the gray - key will backup to the the point where 
  93.          the previous gray + was pressed. 
  94.  
  95.  
  96.  
  97.          Linking with the Gray + key. 
  98.          ---------------------------- 
  99.  
  100.          In Hyper-Word, a highlighted string of text is called a 
  101.          'link origin' or more simply a 'link'. 
  102.  
  103.          Pressing the gray + key while the cursor is at a link origin 
  104.          will jump to the link destination that further defines or 
  105.          explains the highlighted word. 
  106.  
  107.          Pressing the gray - key will backup to the prior link 
  108.          origin. 
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                       2 
  130.  
  131.  
  132.  
  133.  
  134.  
  135.          The Recent Reference list. 
  136.          -------------------------- 
  137.  
  138.          In addition to the gray + key for jumping, and the gray - key 
  139.          for returning, there is one more key for navigating through 
  140.          Hyper-Word documents. 
  141.  
  142.          Pressing the Alt = key (hold down Alt and press =) will 
  143.          display a recent reference list. 
  144.  
  145.          Each line of the recent reference list displays the file name 
  146.          and text of every location that you have recently viewed. 
  147.  
  148.          You can press the Enter key over a desired line to jump 
  149.          directly to the named file and location. 
  150.  
  151.  
  152.  
  153.          Standard Ascii Text Readme Files. 
  154.          --------------------------------- 
  155.  
  156.          The Readme program may use standard ascii text files in 
  157.          addition to files produced with our Hyper-Word word 
  158.          processing program. 
  159.  
  160.          When used with standard text files the text window can be 
  161.          scrolled with the cursor keys. 
  162.  
  163.          Scrolling in either direction is stopped at a Ctrl N 
  164.          character in the readme file, indicating the end of the 
  165.          page. 
  166.  
  167.          The ability to scroll the readme window can be enabled or 
  168.          disabled by setting the '/S=' parameter in the Hyper-Word 
  169.          Readme command line. 
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                       3 
  196.  
  197.  
  198.  
  199.  
  200.  
  201.          Readme Command Line Parameters 
  202.          ------------------------------ 
  203.  
  204.          The Hyper-Word Readme program uses parameters from the 
  205.          command line to decide what file to load, the window size, 
  206.          color and location, and other program variables. 
  207.  
  208.          When you ran Readme you probably typed the following line. 
  209.  
  210.          README 
  211.  
  212.          You could have added a parameter to the command line to 
  213.          select a different file. 
  214.  
  215.          For example, entering; 
  216.  
  217.          README MYFILE 
  218.  
  219.          will load the file MYFILE. 
  220.  
  221.          Other parameters may follow the file name on the command 
  222.          line. 
  223.  
  224.          For example, 
  225.  
  226.          README MYFILE/C=4 
  227.  
  228.          will load MYFILE and set the window color to 4 (blue). 
  229.  
  230.          Parameters following the file name start with a slash '/' 
  231.          followed by a key letter and an equal sign '='. 
  232.  
  233.  
  234.          Valid command line parameters 
  235.          ----------------------------- 
  236.  
  237.          /V=     Video mode, Direct or Bios. 
  238.  
  239.          /C=     Window color, 1=white/black, 2=black/white 
  240.                  3=green/black, 4=white/blue, 5=white/cyan 
  241.  
  242.          /S=     Scroll enable, Yes or No. 
  243.  
  244.          /W=     Window size; top,left,bottom,right. 
  245.  
  246.  
  247.          Any or all of the command line parameters may be entered. 
  248.          The command line should not contain any imbedded spaces. 
  249.  
  250.          Command line parameters that are not entered remain in their 
  251.          default condition. 
  252.  
  253.          The following example sets the window size and window color 
  254.          (3 = green letters on black). 
  255.  
  256.          README /W=1,40,20,80/C=3 
  257.  
  258.  
  259.  
  260.  
  261.                                       4 
  262.  
  263.  
  264.  
  265.  
  266.  
  267.          Video Mode parameter /V= 
  268.          ------------------------ 
  269.  
  270.          The video mode parameter controls the software method that 
  271.          Readme uses to write to the screen. 
  272.  
  273.          The video mode may be set to /V=BIOS or /V=DIRECT. 
  274.  
  275.          The /V=DIRECT mode is slightly faster but may not be 
  276.          compatible with some PC clones. 
  277.  
  278.          Set the video mode to /V=DIRECT unless you experience display 
  279.          problems. 
  280.  
  281.          For example, 
  282.  
  283.          README MYFILE/V=DIRECT 
  284.  
  285.          will cause Readme to load 'MYFILE' and to use the direct 
  286.          video mode. 
  287.  
  288.  
  289.  
  290.          Readme Window Color parameter /C= 
  291.          --------------------------------- 
  292.  
  293.          The /C= parameter selects the colors to be used when 
  294.          displaying the Readme window. 
  295.  
  296.          /C=1 will display white characters on a black background. 
  297.  
  298.          /C=2 will display black characters on a white background. 
  299.  
  300.          /C=3 will display green characters on a black background. 
  301.  
  302.          /C=4 will display white characters on a blue background. 
  303.  
  304.          /C=5 will display white characters on a cyan background.
  305.  
  306.  
  307.  
  308.          Scroll Enable parameter /S= 
  309.          --------------------------- 
  310.  
  311.          The /S= parameter controls whether or not the Readme window 
  312.          can be scrolled. 
  313.  
  314.          If /S=YES then the Readme window can be scrolled. 
  315.  
  316.          If /S=NO then the Readme window cannot be scrolled but can 
  317.          only be moved by pressing the gray + key over highlighted 
  318.          text. 
  319.  
  320.          The window zoom key (Alt 0), the text find feature (F2), and 
  321.          the file load (F7) only work when the scroll is enabled. 
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                       5 
  328.  
  329.  
  330.  
  331.  
  332.  
  333.          Readme Window Size parameter /W= 
  334.          -------------------------------- 
  335.  
  336.          The /W= parameter is used to set the Readme window size and 
  337.          location. 
  338.  
  339.          The /W= should be followed by the window top, left, bottom 
  340.          and right coordinates. 
  341.  
  342.          For example, to set the Readme window to full screen you 
  343.          would enter the following command line. 
  344.  
  345.          README /W=1,1,25,80 
  346.  
  347.  
  348.          If you want to eliminate the left and right side frames of 
  349.          the readme window enter; 
  350.  
  351.          README /W=1,0,25,81 
  352.  
  353.          The top and bottom frames of the readme window cannot be 
  354.          eliminated and will always be displayed. 
  355.  
  356.          Note that the bottom frame of the Readme window displays an 
  357.          up arrow and a down arrow if window scrolling is enabled. 
  358.  
  359.  
  360.          Default command line parameters 
  361.          ------------------------------- 
  362.  
  363.          Unless entered through the command line, the command 
  364.          parameters will have the following default values. 
  365.  
  366.          Filename            README.TXT 
  367.          Video Mode          /V=BIOS 
  368.          Window Color        /C=1          (white on black) 
  369.          Scroll Enable       /S=YES        (scroll works) 
  370.          Window Size         /W=1,0,25,81 
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                       6 
  394.  
  395.  
  396.  
  397.  
  398.  
  399.          Using a Batch file (.BAT) to run Readme 
  400.          --------------------------------------- 
  401.  
  402.          Rather than entering the command line parameters each time 
  403.          you run Readme, you can enter them into a batch file and then 
  404.          run the batch file which will run Readme. 
  405.  
  406.          For example, if you enter the following line into a batch 
  407.          file named 'README.BAT' you can then type 'README' at the DOS 
  408.          prompt to run the program with these preset parameters. 
  409.  
  410.          Contents of README.BAT file; 
  411.  
  412.          README %1/V=Direct/C=4 
  413.  
  414.          The '%1' above is a special DOS replacement parameter.  The 
  415.          %1 in the command line will be automatically replaced with 
  416.          the first word (if any) that you enter after typing 'README' 
  417.          at the DOS prompt. 
  418.  
  419.          If, after creating batch file README.BAT, you 
  420.          enter 'README FILENAME' at the DOS prompt, the %1 symbol in 
  421.          the batch file will be replaced by FILENAME before it is sent 
  422.          to the command processor.  The Readme program will then 
  423.          automatically load and display the file named FILENAME. 
  424.  
  425.          The README.BAT file described above is included on the Readme 
  426.          program disk but it is stored with the name 'RBLUE.BAT'.  To 
  427.          use this file simply copy it to a file named 'README.BAT'. 
  428.  
  429.  
  430.          Mouse Support 
  431.          ------------- 
  432.  
  433.          While in the text window the mouse buttons function as 
  434.          follows; 
  435.  
  436.             Left button  -  Same as gray + key (link jump) 
  437.  
  438.             Right button -  Same as gray - key (link return) 
  439.  
  440.  
  441.          While in a menu or list the mouse buttons function as 
  442.          follows; 
  443.  
  444.             Left button  -  Same as Enter key (select) 
  445.  
  446.             Right button -  Same as Esc key (exit) 
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                       7 
  460.  
  461.  
  462.  
  463.  
  464.  
  465.          Keyword Files 
  466.          ------------- 
  467.  
  468.          Readme has additional command line parameters for setting the 
  469.          names of the optional keyword files as used in our Hyper-Word 
  470.          word processor. 
  471.  
  472.  
  473.          Keyword File Names /1..4= 
  474.          ------------------------- 
  475.  
  476.          The /1=, /2=, /3= and /4= parameters are used to set the 
  477.          names of the keyword files that the Readme system will use. 
  478.  
  479.          Keyword files are used to allow 'many to one' link 
  480.          connections in Hyper-Word Readme.  Keyword files are standard 
  481.          Hyper-Word files that contain link origins. 
  482.  
  483.          When doing a keyword search (F8) or when pressing gray + over 
  484.          an unlinked word, Readme searches the keyword link files for 
  485.          a link origin that matches the keyword for which you are 
  486.          searching. 
  487.  
  488.          If a match is found, Readme jumps to the link destination 
  489.          that is defined for the matching link origin. 
  490.  
  491.          For example, 
  492.  
  493.          README /1=KEYWORDS 
  494.  
  495.          Will set the name of keyword file 1 to KEYWORDS. 
  496.  
  497.          Refer to the documentation for our Hyper-Word word processing 
  498.          program for more information about keyword files. 
  499.  
  500.  
  501.  
  502.          The Printer Initialization File 
  503.          ------------------------------- 
  504.  
  505.          There is one more file used by Readme. 
  506.  
  507.          The file PRT_INIT.TXT contains decimal control codes that 
  508.          will be sent to your printer prior to printing. 
  509.  
  510.          If your printer needs any special codes for initialization, 
  511.          enter them into the PRT_INIT.TXT file. 
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.                                       8 
  526.  
  527.  
  528.  
  529.  
  530.  
  531.          Limitations. 
  532.          ------------ 
  533.  
  534.          Hyper-Word Readme accepts all of the dot commands and 
  535.          functions of our Hyper-Word word processor except as noted 
  536.          below. 
  537.  
  538.          Ctrl Z does not work as a repeat key. 
  539.  
  540.          None of the merge file dot commands operate. 
  541.  
  542.          Only one window opens. (window 1) 
  543.  
  544.          The linked find does not operate. 
  545.  
  546.          No document printing.  Use F9 to print the contents of the 
  547.          Readme window. 
  548.  
  549.          Readme files may not contain the Ctrl A or Ctrl B characters 
  550.          except as defined in our Hyper-Word word processor. 
  551.  
  552.          Hyper-Word Readme is read only. 
  553.  
  554.          If you want Readme to use any keyboard macros that you have 
  555.          created with our Hyper-Word word processing program, you must 
  556.          copy them from directory \EZHWD\ to the directory that you 
  557.          have loaded the Readme program on.   Keyboard macros are the 
  558.          files on directory \EZHWD\ that are named '_A.MAC' through 
  559.          '_Z.MAC'. 
  560.  
  561.  
  562.  
  563.          DISCLAIMER OF ALL WARRANTIES AND LIABILITY 
  564.          ------------------------------------------ 
  565.  
  566.          Zaron Software, Inc. makes no warranties, either express or 
  567.          implied, with respect to this software, its quality, 
  568.          performance, merchantability, or fitness for any particular 
  569.          purpose. 
  570.  
  571.          Zaron Software, Inc. and program author shall have no 
  572.          liability or responsibility to purchaser or to any other 
  573.          person or entity with respect to any liability, loss or 
  574.          damage caused or alleged to be caused by this software, 
  575.          including but not limited to any interruption of service, 
  576.          loss of business or anticipatory profits or consequential 
  577.          damages resulting from the use or operation of this 
  578.          software. 
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.                                       9
  592.